json-schema-org
✨ Enhancement: Publication page for new `format` registry
Is your feature request related to a problem? Please describe
We're looking at starting an official registry for format values. See the proposal issue for more context.
Describe the solution you'd like
We need a place on the website to publish the list of formats. I expect that we'd want something that functions similarly to the tooling page that pulls from a source/data file (which we'd probably keep in the spec repo, but open to keeping it somewhere else).
The page itself needs to be closely associated with the specifications, so alongside those might be a good location.
For now, I think we just need design and publication ideas. Please have a read through the issue linked above to get the full idea we're going for.
Describe alternatives you've considered
No response
Additional context
This discussion should be limited to the page itself. We can take input on what you might need/want from the source/data file, but ultimately its content will be determined by the TSC / Spec Team.
Are you working on this?
No
This is a really cool idea! Thanks, @gregsdennis! Is there an example of pages with similar functionality of what you have in mind?
Also, how will we be storing these formats data, i mean from where will we be fetching the content?
Also, how will we be storing these formats data, i mean from where will we be fetching the content? - @rishabhknowss
We will not be storing anything. We are a list. Many of the formats are defined by our Validation specification. Other formats will be defined by other specifications. We just need to list and perhaps link to where the definition for each format is.
@abhayymishraa I've hidden your comment as it doesn't pertain to this issue. It's more related to the registry itself. This is just how that registry is represented on the site. Your ideas (and please just include the high-level concepts, not the full-blown proposal) should be mentioned there.
I just understood . what about if we built the registry within the website. there will be a specific section for the registry and there we will implement make a interface for the registry of something like openAPI fromat. And we'll make a section where we list and link the defination of each format.
@abhayymishraa The registry will be hosted and managed in Github. The website is just a rendering. I'll continue this discussion offline in Slack.
Also, how will we be storing these formats data, i mean from where will we be fetching the content? - @rishabhknowss
We will not be storing anything. We are a list. Many of the formats are defined by our Validation specification. Other formats will be defined by other specifications. We just need to list and perhaps link to where the definition for each format is.
got it !
@shantanu2107 please read the discourse above. There needs to be discussion on what is to be done before this issue is assigned. There is a screenshot of a mockup someone did as an idea, but we haven't agreed on anything.
We haven't even designed the registry (linked issue) which needs to be done before this work can be done.
Alright, I think we have some ideas on what we're looking for from a technical perspective on the registry. Please see the issue (linked at the top) for that.
@rishabhknowss since it's not too far off from your design, can you make an update that fits the data we're looking for? Your data source will be a file in the spec repository. Also, please describe what any functional parts of your design are supposed to do. Lastly, we need it to fit in with the current website design.
It's also important to note that this is still in progress. We're still in design. No PRs yet, please.
Hello @gregsdennis , is the jsonschema-validation.md file in the spec repository the right source for the format data? Just want to confirm before I proceed. Thanks!
I've opened a new PR that creates a new file. It's linked to the issue.
@rishabhknowss please also have a look at https://spec.openapis.org/registry/format/index.html. We will be inheriting these. I'll make sure they're in the file, but the file schema may need to be updated.
@rishabhknowss please also have a look at https://spec.openapis.org/registry/format/index.html. We will be inheriting these. I'll make sure they're in the file, but the file schema may need to be updated.
Thanks for the update! I'll be looking at it
Hi Greg and everyone. What do you think about adding this project as a project Idea for GSoC 2025?
I don't know that there's really a whole lot to do, and @rishabhknowss has already started designs.
I'd also like it to be done sooner than the northern summer. Hopefully the spec is out before then, and we need this before the spec.
Yes, I agree it won't take much time. Once I'll post the designs (planning to add some functional components) , i would love to code the implementation later.
I don't know that there's really a whole lot to do, and @rishabhknowss has already started designs.
I'd also like it to be done sooner than the northern summer. Hopefully the spec is out before then, and we need this before the spec.
@rishabhknowss let's work collaboratively on this issue if that's alright with you. This will be a great addition to the site
@rishabhknowss let's work collaboratively on this issue if that's alright with you. This will be a great addition to the site
hey @Karan-Palan i'm already working on this issue, if i require your help at any step I'll let you know, thanks :>
@rishabhknowss thanks for the update! This seems like a significant change, and I thought it could benefit from collaborative efforts to cover all aspects efficiently. I’d be happy to assist if needed or help brainstorm ideas.
Hi @gregsdennis @benjagm . I have used the data from specs/format-registry.json I believe the designs have been adjusted to align with the website's theme and should look great :D
Please let me know if you have any feedback.
Format Registry Page Design
Desktop Screen
Mobile Screens
|
|
|
Dark mode
Functional Components
1. Search Box
Search for a specific format by typing its name or keywords.
2. Specification Selector
Choose formats by their specifications (e.g., char under OpenAPI, date-time under JSON Schema).
3. Data Type Filters
Filter formats by String or Number data types.
I like it. Hold onto this, and when we're finalized on the source file and merge that PR, we can finalize this and bring it in.
I like it. Hold onto this, and when we're finalized on the source file and merge that PR, we can finalize this and bring it in.
Okay