From 23f62059118231f6ca7e343d8cb2a92ea3799913 Mon Sep 17 00:00:00 2001 From: taitus Date: Wed, 4 Dec 2019 18:10:42 +0100 Subject: [PATCH 1/4] Remove the unnecessary title --- docs/en/features/graphql.md | 2 -- docs/es/features/graphql.md | 2 -- 2 files changed, 4 deletions(-) diff --git a/docs/en/features/graphql.md b/docs/en/features/graphql.md index d6f4a8d8e..3af124cbc 100644 --- a/docs/en/features/graphql.md +++ b/docs/en/features/graphql.md @@ -1,5 +1,3 @@ -# GraphQL - # API Documentation * [Characteristics](#characteristics) diff --git a/docs/es/features/graphql.md b/docs/es/features/graphql.md index db4994f0d..1d2da841a 100644 --- a/docs/es/features/graphql.md +++ b/docs/es/features/graphql.md @@ -1,5 +1,3 @@ -# GraphQL - # Documentación de la API * [Características](#características) From 3126fe76993b3f642d096f57adb72b56df341917 Mon Sep 17 00:00:00 2001 From: taitus Date: Mon, 9 Dec 2019 16:44:31 +0100 Subject: [PATCH 2/4] Remove accent mark from links These links to sections are broken. We need create these sections with html directly --- docs/es/features/graphql.md | 43 +++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/docs/es/features/graphql.md b/docs/es/features/graphql.md index 1d2da841a..12f45992a 100644 --- a/docs/es/features/graphql.md +++ b/docs/es/features/graphql.md @@ -1,24 +1,25 @@ # Documentación de la API -* [Características](#características) +* [Características](#caracteristicas) * [GraphQL](#graphql) * [Haciendo peticiones a la API](#haciendo-peticiones-a-la-api) * [Clientes soportados](#clientes-soportados) * [GraphiQL](#graphiql) * [Postman](#postman) - * [Librerías HTTP](#librerías-http) -* [Información disponible](#información-disponible) + * [Librerías HTTP](#librerias-http) +* [Información disponible](#informacion-disponible) * [Ejemplos de consultas](#ejemplos-de-consultas) - * [Recuperar un único elemento de una colección](#recuperar-un-único-elemento-de-una-colección) - * [Recuperar una colección completa](#recuperar-una-colección-completa) - * [Paginación](#paginación) - * [Acceder a varios recursos en una única petición](#acceder-a-varios-recursos-en-una-única-petición) + * [Recuperar un único elemento de una colección](#recuperar-un-unico-elemento-de-una-coleccion) + * [Recuperar una colección completa](#recuperar-una-coleccion-completa) + * [Paginación](#paginacion) + * [Acceder a varios recursos en una única petición](#acceder-a-varios-recursos-en-una-unica-peticion) * [Limitaciones de seguridad](#limitaciones-de-seguridad) * [Ejemplo de consulta demasiado profunda](#ejemplo-de-consulta-demasiado-profunda) * [Ejemplo de consulta demasiado compleja](#ejemplo-de-consulta-demasiado-compleja) -* [Ejemplos de código](#ejemplos-de-código) +* [Ejemplos de código](#ejemplos-de-codigo) -## Características + +

Características

* API de sólo lectura * Acceso público, sin autenticación @@ -111,7 +112,8 @@ La consulta debe estar ubicada en un documento JSON válido, como valor de la cl ![Postman POST](../../img/graphql/graphql-postman-post-body.png) -#### Librerías HTTP + +

Librerías HTTP

Por supuesto es posible utilizar cualquier librería HTTP de lenguajes de programación. @@ -120,7 +122,8 @@ Por supuesto es posible utilizar cualquier librería HTTP de lenguajes de progra `User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.115 Safari/537.36` -## Información disponible + +

Información disponible

El fichero [config/api.yml](../../config/api.yml) contiene una lista completa de los modelos (y sus campos) que están expuestos actualmente en la API. @@ -139,8 +142,8 @@ La lista de modelos es la siguiente: ## Ejemplos de consultas -### Recuperar un único elemento de una colección - + +

Recuperar un único elemento de una colección

``` { proposal(id: 2) { @@ -165,7 +168,8 @@ Respuesta: } ``` -### Recuperar una colección completa + +

Recuperar una colección completa

``` { @@ -202,7 +206,8 @@ Respuesta: } ``` -#### Paginación + +

Paginación

Actualmente el número máximo (y por defecto) de elementos que se devuelven en cada página está establecido a 25. Para poder navegar por las distintas páginas es necesario solicitar además información relativa al `endCursor`: @@ -259,9 +264,10 @@ Para recuperar la siguiente página, hay que pasar como parámetro el cursor rec } ``` -### Acceder a varios recursos en una única petición + +

Acceder a varios recursos en una única petición

-Esta consulta solicita información relativa a varios modelos distintos en una única peticion: `Proposal`, `User`, `Geozone` y `Comment`: +Esta consulta solicita información relativa a varios modelos distintos en una única petición: `Proposal`, `User`, `Geozone` y `Comment`: ``` { @@ -427,6 +433,7 @@ La respuesta: } ``` -## Ejemplos de código + +

Ejemplos de código

El directorio [doc/api/examples](https://github.com/consul/consul/tree/master/doc/api/examples/ruby) contiene ejemplos de código para acceder a la API. From d934c63248b2b9925e7efbae2f81bd02477bcba2 Mon Sep 17 00:00:00 2001 From: taitus Date: Mon, 9 Dec 2019 16:49:18 +0100 Subject: [PATCH 3/4] Fix another link to section with accent marks --- docs/es/installation/docker.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/es/installation/docker.md b/docs/es/installation/docker.md index 71d868ce8..a1c456b00 100644 --- a/docs/es/installation/docker.md +++ b/docs/es/installation/docker.md @@ -46,7 +46,8 @@ sudo chmod +x /usr/local/bin/docker-compose Pendiente de ser completado... ¡Se agradecen las Contribuciones! -## Instalación + +

Instalación

Clona el repositorio en tu ordenador y entra en el directorio: ```bash @@ -113,7 +114,7 @@ Pendiente de ser completado... ¡Se agradecen las Contribuciones! ## ¿Tienes problemas? -Ejecute los comandos en el **directorio de CONSUL**, para borrar todas las imágenes y contenedores anteriores del Docker de CONSUL. Luego, reinicie el [proceso de instalación](#instalación) de Docker: +Ejecute los comandos en el **directorio de CONSUL**, para borrar todas las imágenes y contenedores anteriores del Docker de CONSUL. Luego, reinicie el [proceso de instalación](#instalacion) de Docker: 1. Quitar todas las imágenes de CONSUL: ```bash From cdd9bcee59f54b154ab9c1c8a32350c9b0cc9493 Mon Sep 17 00:00:00 2001 From: taitus Date: Mon, 24 Feb 2020 11:18:54 +0100 Subject: [PATCH 4/4] Remove old code in a comment --- docs/es/features/graphql.md | 8 -------- docs/es/installation/docker.md | 1 - 2 files changed, 9 deletions(-) diff --git a/docs/es/features/graphql.md b/docs/es/features/graphql.md index 12f45992a..f50266b7e 100644 --- a/docs/es/features/graphql.md +++ b/docs/es/features/graphql.md @@ -18,7 +18,6 @@ * [Ejemplo de consulta demasiado compleja](#ejemplo-de-consulta-demasiado-compleja) * [Ejemplos de código](#ejemplos-de-codigo) -

Características

* API de sólo lectura @@ -112,7 +111,6 @@ La consulta debe estar ubicada en un documento JSON válido, como valor de la cl ![Postman POST](../../img/graphql/graphql-postman-post-body.png) -

Librerías HTTP

Por supuesto es posible utilizar cualquier librería HTTP de lenguajes de programación. @@ -122,7 +120,6 @@ Por supuesto es posible utilizar cualquier librería HTTP de lenguajes de progra `User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.115 Safari/537.36` -

Información disponible

El fichero [config/api.yml](../../config/api.yml) contiene una lista completa de los modelos (y sus campos) que están expuestos actualmente en la API. @@ -142,7 +139,6 @@ La lista de modelos es la siguiente: ## Ejemplos de consultas -

Recuperar un único elemento de una colección

``` { @@ -168,7 +164,6 @@ Respuesta: } ``` -

Recuperar una colección completa

``` @@ -206,7 +201,6 @@ Respuesta: } ``` -

Paginación

Actualmente el número máximo (y por defecto) de elementos que se devuelven en cada página está establecido a 25. Para poder navegar por las distintas páginas es necesario solicitar además información relativa al `endCursor`: @@ -264,7 +258,6 @@ Para recuperar la siguiente página, hay que pasar como parámetro el cursor rec } ``` -

Acceder a varios recursos en una única petición

Esta consulta solicita información relativa a varios modelos distintos en una única petición: `Proposal`, `User`, `Geozone` y `Comment`: @@ -433,7 +426,6 @@ La respuesta: } ``` -

Ejemplos de código

El directorio [doc/api/examples](https://github.com/consul/consul/tree/master/doc/api/examples/ruby) contiene ejemplos de código para acceder a la API. diff --git a/docs/es/installation/docker.md b/docs/es/installation/docker.md index a1c456b00..6ecb015c2 100644 --- a/docs/es/installation/docker.md +++ b/docs/es/installation/docker.md @@ -46,7 +46,6 @@ sudo chmod +x /usr/local/bin/docker-compose Pendiente de ser completado... ¡Se agradecen las Contribuciones! -

Instalación

Clona el repositorio en tu ordenador y entra en el directorio: