Repository navigation
Stop the docs demanding a key the server does not use - #12
Merged
Merged
Conversation
Opening the generated docs and running any endpoint produced a request
carrying X-Parse-REST-API-Key. Parse ignores that header unless restAPIKey is
configured, which no project psk new generates does - so the docs put a dead
header into every example and implied a gate that was not there.
The spec asserted it unconditionally. Its own comment said "applicationId and
restApiKey are always required", which was true of neither. It is now opt-in:
pass restApiKey: true when the server actually has one. The scheme is still
declared either way, so a reader can see the header exists, but it is only
required when it is real.
The same session also lost time to a wrong application id. Every request needs
X-Parse-Application-Id, the docs page never said what to put there, a guess
came back as a bare {"error":"unauthorized"} naming nothing, and the endpoint
looked broken when the data was fine. SwaggerConfig now takes appId, rendered
into the Authorize dialog as "This server: my-api". The generated project
passes its own. It is not a secret - every client sends it on every request;
the master key is the secret and is never rendered.
Verified both ways: default gives [{applicationId}] on each endpoint and
globally, with restApiKey: true it gives [{applicationId, restApiKey}].
334 tests pass.
This file contains hidden or 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
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.
Opening the generated docs and running any endpoint produced a request carrying X-Parse-REST-API-Key. Parse ignores that header unless restAPIKey is configured, which no project psk new generates does - so the docs put a dead header into every example and implied a gate that was not there.
The spec asserted it unconditionally. Its own comment said "applicationId and restApiKey are always required", which was true of neither. It is now opt-in: pass restApiKey: true when the server actually has one. The scheme is still declared either way, so a reader can see the header exists, but it is only required when it is real.
The same session also lost time to a wrong application id. Every request needs X-Parse-Application-Id, the docs page never said what to put there, a guess came back as a bare {"error":"unauthorized"} naming nothing, and the endpoint looked broken when the data was fine. SwaggerConfig now takes appId, rendered into the Authorize dialog as "This server: my-api". The generated project passes its own. It is not a secret - every client sends it on every request; the master key is the secret and is never rendered.
Verified both ways: default gives [{applicationId}] on each endpoint and
globally, with restApiKey: true it gives [{applicationId, restApiKey}].
334 tests pass.