Add API methods to get schema information #2767
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This fetches all the Publisher Schemas and marshals them into a key/value arrangement, removing the filepath and replacing with the schema name
This allows us to fetch a schema for a particular content type, throwing an error if there is no such schema found
brucebolt
approved these changes
Jun 11, 2024
Harriethw
reviewed
Jun 11, 2024
| @@ -0,0 +1,50 @@ | |||
| RSpec.describe V2::SchemasController do | |||
There was a problem hiding this comment.
does there also need to be a request spec?
There was a problem hiding this comment.
I guess I'm kinda doing a request spec over a controller spec here, as I guess controller specs are more designed to be "unit-type" tests, so I think I'll switch over 👍
Harriethw
reviewed
Jun 11, 2024
| @@ -0,0 +1,8 @@ | |||
| class SchemaService | |||
| def self.all_schemas | |||
| format_regex = Regexp.new(".+\/formats\/([a-z_]+)\/.+") | |||
There was a problem hiding this comment.
so here we are using the file path to get the type of object the schema is for? Is there any other way to get the type, e.g. in the schema itself with a title key for instance? Just wondering if there's a risk depending on a file path set in another gem which could easily change...
There was a problem hiding this comment.
After chat with @pezholio There is no codified place for the name/type except in folder name
This adds controller methods that call the relevant service method and return the result as JSON
pezholio
force-pushed
the
add-api-methods-to-get-schema-information
branch
from
8b47701
to
555611f
Compare
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 12, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1]
This adds methods to the publishing_api adapter
[1] alphagov/publishing-api#2767
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 12, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1].
This adds helper methods to stub responses to these
end points.
[1] alphagov/publishing-api#2767
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 12, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1]
This adds methods to the publishing_api adapter
[1] alphagov/publishing-api#2767
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 12, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1].
This adds helper methods to stub responses to these
end points.
[1] alphagov/publishing-api#2767
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 13, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1].
This adds helper methods to stub responses to these
end points.
[1] alphagov/publishing-api#2767
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 13, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1].
This adds helper methods to stub responses to these
end points.
[1] alphagov/publishing-api#2767
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 14, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1]
This adds methods to the publishing_api adapter
[1] alphagov/publishing-api#2767
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 14, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1].
This adds helper methods to stub responses to these
end points.
[1] alphagov/publishing-api#2767
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 14, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1].
This adds helper methods to stub responses to these
end points.
[1] alphagov/publishing-api#2767
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 14, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1]
This adds methods to the publishing_api adapter
[1] alphagov/publishing-api#2767
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 14, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1].
This adds helper methods to stub responses to these
end points.
[1] alphagov/publishing-api#2767
tahb
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 17, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1]
This adds methods to the publishing_api adapter
[1] alphagov/publishing-api#2767
Co-authored-by: Tom Hipkin <tomhipkin@gmail.com>
Co-authored-by: Harriet H-W <harriethw@gmail.com>
tahb
pushed a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 17, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1].
This adds helper methods to stub responses to these
end points.
[1] alphagov/publishing-api#2767
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 18, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1]
This adds methods to the publishing_api adapter
[1] alphagov/publishing-api#2767
Co-authored-by: Tom Hipkin <tomhipkin@gmail.com>
Co-authored-by: Harriet H-W <harriethw@gmail.com>
Harriethw
added a commit
to alphagov/gds-api-adapters
that referenced
this pull request
Jun 18, 2024
`/schemas` and `/schemas/{schema_name}` were added
to the Publishing API in this PR [1].
This adds helper methods to stub responses to these
end points.
[1] alphagov/publishing-api#2767
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds some API methods to return information about the schemas that Publishing API knows about, as well as fetching a schema by name. This allows us to get up to date schema information without having to have a local copy of the schemas stored somewhere and using the GOV.UK Schemas gem.
This will allow the content modelling team to have a way to create many different types of reusable content using the Publishing API as a single source of truth for the schema, rather than having to keep fields, validation rules etc in two places.
Happy to chat through in more detail if anyone needs any more context / has any questions!