From 02925fced1e55c7b35ff65316b10f1fc1a1cd94e Mon Sep 17 00:00:00 2001 From: lenkan Date: Tue, 10 Oct 2023 10:24:30 +0200 Subject: [PATCH] fix spelling errors --- src/keria/app/aiding.py | 36 ++++++++++++++++----------------- src/keria/app/credentialing.py | 16 +++++++-------- src/keria/app/grouping.py | 2 +- src/keria/app/notifying.py | 4 ++-- src/keria/peer/exchanging.py | 6 +++--- tests/app/test_credentialing.py | 12 +++++------ tests/app/test_specing.py | 34 +++++++++++++++---------------- 7 files changed, 55 insertions(+), 55 deletions(-) diff --git a/src/keria/app/aiding.py b/src/keria/app/aiding.py index 1f81a4d3..6129249f 100644 --- a/src/keria/app/aiding.py +++ b/src/keria/app/aiding.py @@ -615,7 +615,7 @@ def info(hab, rm, full=False): class IdentifierOOBICollectionEnd: """ - This class represents the OOBI subresource collection endpoint for Identfiiers + This class represents the OOBI subresource collection endpoint for identifiers """ @@ -833,12 +833,12 @@ def on_get(req, rep): content: application/json: schema: - description: Randon word list + description: Random word list type: object properties: words: type: array - description: random challange word list + description: random challenge word list items: type: string @@ -864,10 +864,10 @@ def on_post(req, rep, name): Parameters: req: falcon.Request HTTP request rep: falcon.Response HTTP response - name: human readable name of identifier to use to sign the challange/response + name: human readable name of identifier to use to sign the challenge/response --- - summary: Sign challange message and forward to peer identfiier + summary: Sign challenge message and forward to peer identifier description: Sign a challenge word list received out of bands and send `exn` peer to peer message to recipient tags: @@ -927,11 +927,11 @@ def on_post(req, rep, name, source): Parameters: req: falcon.Request HTTP request rep: falcon.Response HTTP response - name: human readable name of identifier to use to sign the challange/response + name: human readable name of identifier to use to sign the challenge/response source: qb64 AID of of source of signed response to verify --- - summary: Sign challange message and forward to peer identfiier + summary: Sign challenge message and forward to peer identifier description: Sign a challenge word list received out of bands and send `exn` peer to peer message to recipient tags: @@ -987,7 +987,7 @@ def on_put(req, rep, name, source): Parameters: req: falcon.Request HTTP request rep: falcon.Response HTTP response - name: human readable name of identifier to use to sign the challange/response + name: human readable name of identifier to use to sign the challenge/response source: qb64 AID of of source of signed response to verify --- @@ -1152,8 +1152,8 @@ def on_post(req, rep, prefix): prefix: qb64 identifier prefix of contact to associate with image --- - summary: Uploads an image to associate with identfier. - description: Uploads an image to associate with identfier. + summary: Uploads an image to associate with identifier. + description: Uploads an image to associate with identifier. tags: - Contacts parameters: @@ -1246,8 +1246,8 @@ def on_get(req, rep, prefix): prefix: qb64 identifier prefix of contact information to get --- - summary: Get contact information associated with single remote identfier - description: Get contact information associated with single remote identfier. All + summary: Get contact information associated with single remote identifier + description: Get contact information associated with single remote identifier. All information is meta-data and kept in local storage only tags: - Contacts @@ -1309,7 +1309,7 @@ def on_post(req, rep, prefix): 200: description: Updated contact information for remote identifier 400: - description: Invalid identfier used to update contact information + description: Invalid identifier used to update contact information 404: description: Prefix not found in identifier contact information """ @@ -1345,8 +1345,8 @@ def on_put(req, rep, prefix): prefix: qb64 identifier to update contact information --- - summary: Update provided fields in contact information associated with remote identfier prefix - description: Update provided fields in contact information associated with remote identfier prefix. All + summary: Update provided fields in contact information associated with remote identifier prefix + description: Update provided fields in contact information associated with remote identifier prefix. All information is metadata and kept in local storage only tags: - Contacts @@ -1369,7 +1369,7 @@ def on_put(req, rep, prefix): 200: description: Updated contact information for remote identifier 400: - description: Invalid identfier used to update contact information + description: Invalid identifier used to update contact information 404: description: Prefix not found in identifier contact information """ @@ -1402,8 +1402,8 @@ def on_delete(req, rep, prefix): prefix: qb64 identifier prefix to delete contact information --- - summary: Delete contact information associated with remote identfier - description: Delete contact information associated with remote identfier + summary: Delete contact information associated with remote identifier + description: Delete contact information associated with remote identifier tags: - Contacts parameters: diff --git a/src/keria/app/credentialing.py b/src/keria/app/credentialing.py index d0f08517..85bb4771 100644 --- a/src/keria/app/credentialing.py +++ b/src/keria/app/credentialing.py @@ -79,7 +79,7 @@ def on_get(req, rep, name): hab = agent.hby.habByName(name) if hab is None: - raise falcon.HTTPNotFound(description="name is not a valid reference to an identfier") + raise falcon.HTTPNotFound(description="name is not a valid reference to an identifier") res = [] for name, registry in agent.rgy.regs.items(): @@ -136,7 +136,7 @@ def on_post(self, req, rep, name): type: array items: type: string - description: List of qb64 AIDs of witnesses to be used for the new group identfier. + description: List of qb64 AIDs of witnesses to be used for the new group identifier. estOnly: type: boolean required: false @@ -159,7 +159,7 @@ def on_post(self, req, rep, name): hab = agent.hby.habByName(name) if hab is None: - raise falcon.HTTPNotFound(description="alias is not a valid reference to an identfier") + raise falcon.HTTPNotFound(description="alias is not a valid reference to an identifier") registry = agent.rgy.makeSignifyRegistry(name=rname, prefix=hab.pre, regser=vcp) @@ -207,7 +207,7 @@ def on_get(req, rep, name, registryName): hab = agent.hby.habByName(name) if hab is None: - raise falcon.HTTPNotFound(description=f"{name} is not a valid reference to an identfier") + raise falcon.HTTPNotFound(description=f"{name} is not a valid reference to an identifier") registry = agent.rgy.registryByName(registryName) if registry is None: @@ -354,7 +354,7 @@ def on_post(req, rep, name): agent = req.context.agent hab = agent.hby.habByName(name) if hab is None: - raise falcon.HTTPNotFound(description="name is not a valid reference to an identfier") + raise falcon.HTTPNotFound(description="name is not a valid reference to an identifier") try: body = req.get_media() @@ -473,7 +473,7 @@ def on_post(self, req, rep, name): body = req.get_media() hab = agent.hby.habByName(name) if hab is None: - raise falcon.HTTPNotFound(description="name is not a valid reference to an identfier") + raise falcon.HTTPNotFound(description="name is not a valid reference to an identifier") creder = proving.Creder(ked=httping.getRequiredParam(body, "acdc")) iserder = coring.Serder(ked=httping.getRequiredParam(body, "iss")) @@ -559,7 +559,7 @@ def on_get(req, rep, name, said): hab = agent.hby.habByName(name) if hab is None: - raise falcon.HTTPNotFound(description="name is not a valid reference to an identfier") + raise falcon.HTTPNotFound(description="name is not a valid reference to an identifier") accept = req.get_header("accept") if accept == "application/json+cesr": @@ -650,7 +650,7 @@ def on_delete(self, req, rep, name, said): body = req.get_media() hab = agent.hby.habByName(name) if hab is None: - raise falcon.HTTPNotFound(description="name is not a valid reference to an identfier") + raise falcon.HTTPNotFound(description="name is not a valid reference to an identifier") rserder = coring.Serder(ked=httping.getRequiredParam(body, "rev")) diff --git a/src/keria/app/grouping.py b/src/keria/app/grouping.py index 25acf315..a2768ab2 100644 --- a/src/keria/app/grouping.py +++ b/src/keria/app/grouping.py @@ -40,7 +40,7 @@ def on_post(req, rep, name): # Get the hab hab = agent.hby.habByName(name) if hab is None: - raise falcon.HTTPNotFound(description=f"alias={name} is not a valid reference to an identfier") + raise falcon.HTTPNotFound(description=f"alias={name} is not a valid reference to an identifier") # ...and make sure we're a Group if not isinstance(hab, habbing.SignifyGroupHab): diff --git a/src/keria/app/notifying.py b/src/keria/app/notifying.py index b128185c..a8781c5f 100644 --- a/src/keria/app/notifying.py +++ b/src/keria/app/notifying.py @@ -29,8 +29,8 @@ def on_get(req, rep): req: falcon.Request HTTP request rep: falcon.Response HTTP response --- - summary: Get list of notifcations for the controller of the agent - description: Get list of notifcations for the controller of the agent. Notifications will + summary: Get list of notifications for the controller of the agent + description: Get list of notifications for the controller of the agent. Notifications will be sorted by creation date/time parameters: - in: header diff --git a/src/keria/peer/exchanging.py b/src/keria/peer/exchanging.py index c09c5053..c315d166 100644 --- a/src/keria/peer/exchanging.py +++ b/src/keria/peer/exchanging.py @@ -43,7 +43,7 @@ def on_post(req, rep, name): # Get the hab hab = agent.hby.habByName(name) if hab is None: - raise falcon.HTTPNotFound(description=f"alias={name} is not a valid reference to an identfier") + raise falcon.HTTPNotFound(description=f"alias={name} is not a valid reference to an identifier") # Get the exn, sigs, additional attachments and recipients from the request ked = httping.getRequiredParam(body, "exn") @@ -101,7 +101,7 @@ def on_post(req, rep, name): agent = req.context.agent hab = agent.hby.habByName(name) if hab is None: - raise falcon.HTTPNotFound(description="name is not a valid reference to an identfier") + raise falcon.HTTPNotFound(description="name is not a valid reference to an identifier") try: body = req.get_media() @@ -162,7 +162,7 @@ def on_get(req, rep, name, said): # Get the hab hab = agent.hby.habByName(name) if hab is None: - raise falcon.HTTPNotFound(description=f"alias={name} is not a valid reference to an identfier") + raise falcon.HTTPNotFound(description=f"alias={name} is not a valid reference to an identifier") serder, pathed = exchanging.cloneMessage(agent.hby, said) diff --git a/tests/app/test_credentialing.py b/tests/app/test_credentialing.py index 5fef2bef..fdc787fe 100644 --- a/tests/app/test_credentialing.py +++ b/tests/app/test_credentialing.py @@ -146,12 +146,12 @@ def test_registry_end(helpers, seeder): body = dict(name="test", alias="test", vcp=regser.ked, ixn=serder.ked, sigs=sigers) result = client.simulate_post(path="/identifiers/bad_test/registries", body=json.dumps(body).encode("utf-8")) assert result.status == falcon.HTTP_404 - assert result.json == {'description': 'alias is not a valid reference to an identfier', 'title': '404 Not Found'} + assert result.json == {'description': 'alias is not a valid reference to an identifier', 'title': '404 Not Found'} result = client.simulate_get(path="/identifiers/not_test/registries") assert result.status == falcon.HTTP_404 - assert result.json == {'description': 'name is not a valid reference to an identfier', 'title': '404 Not Found'} + assert result.json == {'description': 'name is not a valid reference to an identifier', 'title': '404 Not Found'} # Test Operation Resource result = client.simulate_get(path=f"/operations/{op['name']}") @@ -243,7 +243,7 @@ def test_issue_credential(helpers, seeder): result = client.simulate_post(path="/identifiers/badname/credentials", body=json.dumps(body).encode("utf-8")) assert result.status_code == 404 - assert result.json == {'description': "name is not a valid reference to an identfier", + assert result.json == {'description': "name is not a valid reference to an identifier", 'title': '404 Not Found'} result = client.simulate_post(path="/identifiers/issuer/credentials", body=json.dumps(body).encode("utf-8")) @@ -322,7 +322,7 @@ def test_credentialing_ends(helpers, seeder): res = client.simulate_post(f"/identifiers/{hab.name}/credentials/query") assert res.status_code == 404 - assert res.json == {'description': 'name is not a valid reference to an identfier', + assert res.json == {'description': 'name is not a valid reference to an identifier', 'title': '404 Not Found'} res = client.simulate_post(f"/identifiers/test/credentials/query") @@ -469,7 +469,7 @@ def test_revoke_credential(helpers, seeder): result = client.simulate_post(path="/identifiers/badname/credentials", body=json.dumps(body).encode("utf-8")) assert result.status_code == 404 - assert result.json == {'description': "name is not a valid reference to an identfier", + assert result.json == {'description': "name is not a valid reference to an identifier", 'title': '404 Not Found'} result = client.simulate_post(path="/identifiers/issuer/credentials", body=json.dumps(body).encode("utf-8")) @@ -505,7 +505,7 @@ def test_revoke_credential(helpers, seeder): sigs=sigers) res = client.simulate_delete(path=f"/identifiers/badname/credentials/{creder.said}", body=json.dumps(body).encode("utf-8")) assert res.status_code == 404 - assert res.json == {'description': "name is not a valid reference to an identfier", + assert res.json == {'description': "name is not a valid reference to an identifier", 'title': '404 Not Found'} res = client.simulate_delete(path=f"/identifiers/issuer/credentials/{regser.said}", body=json.dumps(body).encode("utf-8")) diff --git a/tests/app/test_specing.py b/tests/app/test_specing.py index 1163dea7..7efc129c 100644 --- a/tests/app/test_specing.py +++ b/tests/app/test_specing.py @@ -86,8 +86,8 @@ def test_spec_resource(helpers): '"name": "strength", "schema": {"type": "int"}, "description": "cryptographic ' 'strength of word list", "required": false}], "responses": {"200": ' '{"description": "An array of random words", "content": {"application/json": ' - '{"schema": {"description": "Randon word list", "type": "object", ' - '"properties": {"words": {"type": "array", "description": "random challange ' + '{"schema": {"description": "Random word list", "type": "object", ' + '"properties": {"words": {"type": "array", "description": "random challenge ' 'word list", "items": {"type": "string"}}}}}}}}}}, "/contacts": {"get": ' '{"summary": "Get list of contact information associated with remote ' 'identifiers", "description": "Get list of contact information associated ' @@ -100,8 +100,8 @@ def test_spec_resource(helpers): '{"type": "string"}, "description": "value to search for", "required": ' 'false}], "responses": {"200": {"description": "List of contact information ' 'for remote identifiers"}}}}, "/notifications": {"get": {"summary": "Get list ' - 'of notifcations for the controller of the agent", "description": "Get list ' - 'of notifcations for the controller of the agent. Notifications will be ' + 'of notifications for the controller of the agent", "description": "Get list ' + 'of notifications for the controller of the agent. Notifications will be ' 'sorted by creation date/time", "parameters": [{"in": "header", "name": ' '"Range", "schema": {"type": "string"}, "required": false, "description": ' '"size of the result list. Defaults to 25"}], "tags": ["Notifications"], ' @@ -125,7 +125,7 @@ def test_spec_resource(helpers): '"object"}}}}}}}, "/agent/{caid}": {"get": {}, "put": {}}, ' '"/identifiers/{name}": {"get": {}, "put": {}}, "/endroles/{aid}": {"get": ' '{}, "post": {}}, "/escrows/rpy": {"get": {}}, "/challenges/{name}": {"post": ' - '{"summary": "Sign challange message and forward to peer identfiier", ' + '{"summary": "Sign challenge message and forward to peer identifier", ' '"description": "Sign a challenge word list received out of bands and send ' '`exn` peer to peer message to recipient", "tags": ["Challenge/Response"], ' '"parameters": [{"in": "path", "name": "name", "schema": {"type": "string"}, ' @@ -137,16 +137,16 @@ def test_spec_resource(helpers): '"challenge in form of word list", "items": {"type": "string"}}}}}}}, ' '"responses": {"202": {"description": "Success submission of signed ' 'challenge/response"}}}}, "/contacts/{prefix}": {"delete": {"summary": ' - '"Delete contact information associated with remote identfier", ' + '"Delete contact information associated with remote identifier", ' '"description": "Delete contact information associated with remote ' - 'identfier", "tags": ["Contacts"], "parameters": [{"in": "path", "name": ' + 'identifier", "tags": ["Contacts"], "parameters": [{"in": "path", "name": ' '"prefix", "schema": {"type": "string"}, "required": true, "description": ' '"qb64 identifier prefix of contact to delete"}], "responses": {"202": ' '{"description": "Contact information successfully deleted for prefix"}, ' '"404": {"description": "No contact information found for prefix"}}}, "get": ' '{"summary": "Get contact information associated with single remote ' - 'identfier", "description": "Get contact information associated with single ' - 'remote identfier. All information is meta-data and kept in local storage ' + 'identifier", "description": "Get contact information associated with single ' + 'remote identifier. All information is meta-data and kept in local storage ' 'only", "tags": ["Contacts"], "parameters": [{"in": "path", "name": "prefix", ' '"schema": {"type": "string"}, "required": true, "description": "qb64 ' 'identifier prefix of contact to get"}], "responses": {"200": {"description": ' @@ -161,11 +161,11 @@ def test_spec_resource(helpers): '{"application/json": {"schema": {"description": "Contact information", ' '"type": "object"}}}}, "responses": {"200": {"description": "Updated contact ' 'information for remote identifier"}, "400": {"description": "Invalid ' - 'identfier used to update contact information"}, "404": {"description": ' + 'identifier used to update contact information"}, "404": {"description": ' '"Prefix not found in identifier contact information"}}}, "put": {"summary": ' '"Update provided fields in contact information associated with remote ' - 'identfier prefix", "description": "Update provided fields in contact ' - 'information associated with remote identfier prefix. All information is ' + 'identifier prefix", "description": "Update provided fields in contact ' + 'information associated with remote identifier prefix. All information is ' 'metadata and kept in local storage only", "tags": ["Contacts"], ' '"parameters": [{"in": "path", "name": "prefix", "schema": {"type": ' '"string"}, "required": true, "description": "qb64 identifier prefix to add ' @@ -173,7 +173,7 @@ def test_spec_resource(helpers): '{"application/json": {"schema": {"description": "Contact information", ' '"type": "object"}}}}, "responses": {"200": {"description": "Updated contact ' 'information for remote identifier"}, "400": {"description": "Invalid ' - 'identfier used to update contact information"}, "404": {"description": ' + 'identifier used to update contact information"}, "404": {"description": ' '"Prefix not found in identifier contact information"}}}}, ' '"/notifications/{said}": {"delete": {"summary": "Delete notification", ' '"description": "Delete notification", "tags": ["Notifications"], ' @@ -199,8 +199,8 @@ def test_spec_resource(helpers): 'retrieved for prefix", "content": {"image/jpg": {"schema": {"description": ' '"Image", "type": "binary"}}}}, "404": {"description": "No contact ' 'information found for prefix"}}}, "post": {"summary": "Uploads an image to ' - 'associate with identfier.", "description": "Uploads an image to associate ' - 'with identfier.", "tags": ["Contacts"], "parameters": [{"in": "path", ' + 'associate with identifier.", "description": "Uploads an image to associate ' + 'with identifier.", "tags": ["Contacts"], "parameters": [{"in": "path", ' '"name": "prefix", "schema": {"type": "string"}, "description": "identifier ' 'prefix to associate image to", "required": true}], "requestBody": ' '{"required": true, "content": {"image/jpg": {"schema": {"type": "string", ' @@ -208,8 +208,8 @@ def test_spec_resource(helpers): '"binary"}}}}, "responses": {"200": {"description": "Image successfully ' 'uploaded"}}}}, "/oobi/{aid}/{role}": {"get": {}}, ' '"/identifiers/{name}/endroles/{role}": {"get": {}, "post": {}}, ' - '"/challenges/{name}/verify/{source}": {"post": {"summary": "Sign challange ' - 'message and forward to peer identfiier", "description": "Sign a challenge ' + '"/challenges/{name}/verify/{source}": {"post": {"summary": "Sign challenge ' + 'message and forward to peer identifier", "description": "Sign a challenge ' 'word list received out of bands and send `exn` peer to peer message to ' 'recipient", "tags": ["Challenge/Response"], "parameters": [{"in": "path", ' '"name": "name", "schema": {"type": "string"}, "required": true, '