Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[gh-pages] draft format registry, add uuid - example for Ted/Marsh #1811

Closed
wants to merge 1 commit into from

Conversation

MikeRalphson
Copy link
Member

OAS Registry entry submission

Each PR should create one new .md file within the registries/_[registry-name] directory on the gh-pages branch.

Please make sure you have completed all of the necessary information in the YAML front-matter:

  • issue - each submission MUST be linked to an original issue
  • owner this should be your or the issue originator's GitHub id
  • description - a short description of the registry entry
For an extension:
  • schema - a JSON Schema for the extension
  • objects - an array of object names where the extension can appear. The empty array ([]) indicates the extension may appear anywhere specification extensions are allowed
For a format:
  • base_type - the type to which this format applies (e.g. string, integer etc)
For a ...
For a ...

Template

  • The template section should include an example where relevant, and any links to supporting standards or documentation.

@darrelmiller
Copy link
Member

Thoughts @tedepstein ?

@MikeRalphson
Copy link
Member Author

Note: uuid is soon not going to be a good example, as it is defined in JSON Schema Draft 2019-09.

@MikeRalphson
Copy link
Member Author

Closing this as @darrelmiller and @baywet have successfully updated the registry with new categories and entries without such a template. We can always revisit later.

@earth2marsh earth2marsh removed their assignment Mar 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants