Skip to content

Adding documentation for Hermes resources#289

Merged
rogelioLpz merged 5 commits intomainfrom
docs
Jun 30, 2022
Merged

Adding documentation for Hermes resources#289
rogelioLpz merged 5 commits intomainfrom
docs

Conversation

@chiqeen03
Copy link
Contributor

@chiqeen03 chiqeen03 commented Jun 28, 2022

Adding description for resources in Hermes.

@chiqeen03 chiqeen03 self-assigned this Jun 28, 2022
@codecov
Copy link

codecov bot commented Jun 28, 2022

Codecov Report

Merging #289 (03cf387) into main (9292f88) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main      #289   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           43        43           
  Lines         1005      1010    +5     
=========================================
+ Hits          1005      1010    +5     
Flag Coverage Δ
unittests 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
cuenca/resources/endpoints.py 100.00% <100.00%> (ø)
cuenca/resources/webhooks.py 100.00% <100.00%> (ø)
cuenca/version.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9292f88...03cf387. Read the comment docs.

@chiqeen03 chiqeen03 added the documentation Improvements or additions to documentation label Jun 29, 2022
@chiqeen03 chiqeen03 marked this pull request as ready for review June 29, 2022 14:41
@chiqeen03 chiqeen03 requested a review from alexviquez as a code owner June 29, 2022 14:41
}
schema_extra = {
'example': {
"_id": "ENxxne2Z5VSTKZm_w8Hzffcw",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

comillas simples para todo

fields = {
'url': {'description': 'HTTPS url to send webhooks'},
'secret': {
'description': 'token to verify the webhook is sent by Cuenca'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

puedes poner el algoritmo que se usa para la validación porfa
me parece que es hmac

Comment on lines 41 to 42
"created_at": {"$date": {"$numberLong": "1645752962234"}},
"updated_at": {"$date": {"$numberLong": "1645752962234"}},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Las fechas como string

Comment on lines 30 to 39
"""
Creates and Endpoint, allowing to recieve Webhooks with the specified
events.

:param url: HTTPS url to send webhooks
:param events: list of enabled events. If None, all events will be
enabled for this Endpoint
:param session:
:return: New active endpoint
"""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Esta es mejor que se quede es la descripcion que sale en los ides

pachCode
pachCode previously approved these changes Jun 29, 2022
pachCode
pachCode previously approved these changes Jun 29, 2022
@rogelioLpz rogelioLpz merged commit 0fa0d0d into main Jun 30, 2022
@rogelioLpz rogelioLpz deleted the docs branch June 30, 2022 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants